Fix errors, typos, grammar, and broken link in site documentation - #633
Open
elharo wants to merge 6 commits into
Open
Fix errors, typos, grammar, and broken link in site documentation#633elharo wants to merge 6 commits into
elharo wants to merge 6 commits into
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the Maven WAR Plugin site documentation to correct typos/grammar, fix a broken external link, and improve the accuracy/clarity of goal references and notes.
Changes:
- Fixes multiple spelling/grammar issues across APT docs (e.g., “development”, “artifacts match”, phrasing tweaks).
- Updates the goals overview text to correct an incorrect goal reference.
- Rewords a note in the WAR manifest guide for clearer meaning and updates the Jetty plugin documentation link.
Reviewed changes
Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| src/site/apt/usage.apt.vm | Corrects a typo in the “development” wording in the war:exploded usage section (but still needs a goal-name fix). |
| src/site/apt/overlays.apt.vm | Grammar and phrasing fixes in overlay configuration documentation. |
| src/site/apt/index.apt.vm | Corrects “development” typo and updates war:inplace description to reference the correct goal. |
| src/site/apt/examples/war-manifest-guide.apt.vm | Clarifies a note about dependency inclusion vs manifest classpath. |
| src/site/apt/examples/rapid-testing-jetty6-plugin.apt | Replaces a dead Codehaus link with a new Jetty plugin documentation URL (but currently mismatched to Jetty 6 example coordinates). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| The command will block with Jetty listening on port 8080. | ||
|
|
||
| Check the {{{http://docs.codehaus.org/display/JETTY/Maven+Jetty+Plugin}Jetty Plugin documentation}} for more details. | ||
| Check the {{{https://jetty.org/docs/jetty/12/programming-guide/maven-jetty/jetty-maven-plugin.html}Jetty Plugin documentation}} for more details. |
Contributor
Author
There was a problem hiding this comment.
@copilot your suggested link does not point to the docs. Do you have a better one?
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 5 out of 5 changed files in this pull request and generated no new comments.
Suppressed comments (3)
src/site/apt/examples/rapid-testing-jetty6-plugin.apt:75
- This page configures the legacy Jetty 6 plugin (
org.mortbay.jetty:maven-jetty-plugin:6.1.10), but the link points to the Jetty 12 Maven plugin docs, which uses different coordinates and configuration and is likely to confuse readers. Consider linking to an archived copy of the original Jetty 6 Maven plugin documentation instead.
Check the {{{https://jetty.org/docs/jetty/12/programming-guide/maven-jetty/jetty-maven-plugin.html}Jetty Plugin documentation}} for more details.
src/site/apt/usage.apt.vm:134
- The line wrap/indentation here breaks the paragraph formatting within the list item (the continuation line is less indented), and the wording is slightly inaccurate: the
war:explodedgoal creates an exploded webapp directory (seeWarExplodedMojo), not a WAR file "in exploded form".
To speed up testing during the development phase, <<<war:exploded>>> can generate the WAR in exploded
form.
Use the same project as above and invoke:
src/site/apt/index.apt.vm:45
- This bullet is indented one space more than the other items in the same list, which will render it as a nested list item in APT rather than a peer item.
* {{{./inplace-mojo.html}war:inplace}} is another variation of <<<war:exploded>>>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes across 5 files:
Errors of fact:
Typos:
Grammar:
Awkward phrasing: